/*
 * Copyright 2007-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.ymate.platform.persistence.jdbc.query.annotation;

import org.apache.commons.lang3.StringUtils;

import java.lang.annotation.*;

/**
 * 定义一个查询目标
 *
 * @author 刘镇 (suninformation@163.com) on 2020/04/16 19:43
 * @since 2.1.0
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(QFroms.class)
public @interface QFrom {

    /**
     * @return 前缀
     */
    String prefix() default StringUtils.EMPTY;

    /**
     * @return 表名或SQL语句字符串
     */
    String value();

    /**
     * @return 别名
     */
    String alias() default StringUtils.EMPTY;

    /**
     * @return 值类型，默认为：表
     */
    Type type() default Type.TABLE;

    /**
     * 值类型枚举
     */
    enum Type {

        /**
         * 表
         */
        TABLE,

        /**
         * SQL语句
         */
        SQL
    }
}
